Pass OpenAPI document to Context class constructor by Copilot · Pull Request #1638 · counterfact/api-simulator

Copilot · 2026-04-03T22:53:00Z

Summary

The Context class in _.context.ts had no way to access the loaded OpenAPI document at construction time. This change passes it as openApiDocument in the constructor options object, alongside the existing loadContext and readJson helpers. When the OpenAPI spec changes on disk, the OpenApiDocument class updates its own properties in-place (via watch() → load()), and the Context automatically sees the latest spec through a stable read-only Proxy.

// routes/_.context.ts
export class Context {
  constructor({ openApiDocument, loadContext, readJson }) {
    this.spec = openApiDocument; // stays up-to-date as the spec changes on disk
  }
}

Original Prompt

Pass the loaded OpenAPI document to the Context class constructor so route handlers can access spec metadata at runtime.

Manual acceptance tests

_.context.ts constructor receives openApiDocument and it matches the loaded spec (e.g. openApiDocument.paths contains the routes defined in the YAML)
Existing _.context.ts files with no constructor argument continue to work unchanged
loadContext and readJson still work correctly alongside openApiDocument
When no OpenAPI document is provided (e.g. openApiPath === "_"), openApiDocument is an empty object — not undefined or an error
After editing the OpenAPI spec file while the server is running, a Context that stored openApiDocument reflects the updated spec through the same proxy reference
Attempting to set or delete properties on openApiDocument inside a Context does not throw and has no effect (read-only)

Tasks

Added optional openApiDocument?: OpenApiDocument parameter (6th position, after scenariosPath and scenarioRegistry) to ModuleLoader constructor; imported OpenApiDocument type from openapi-document.ts
Created a simplified read-only Proxy wrapping the provided OpenApiDocument instance (or {} when none is given); since the OpenApiDocument class updates its own properties in-place on reload, no openApiDocumentRef indirection or setOpenApiDocument method is needed
The Proxy returns false for set and deleteProperty traps, making it read-only; reads delegate to the underlying object so in-place updates are immediately visible
Passed this.openApiDocumentProxy into the Context constructor options object
In app.ts, forwarded openApiDocument as the 6th argument to ModuleLoader in both counterfact() and createMswHandlers(); removed the now-redundant codeGenerator.generate event listener (spec reloads are handled by openApiDocument?.watch())
Removed duplicate optional OpenApiDocument interface from dispatcher.ts; kept main's required-paths version
Merged origin/main changes: ScenarioRegistry support in ModuleLoader, writeApplyContextType on context changes, openApiDocument?.watch() / openApiDocument?.stopWatching() lifecycle, and the new OpenApiDocument class in openapi-document.ts
Fixed TypeScript error in src/repl/route-builder.ts: extracted paths ?? {} to a local variable before Object.keys() so the loop body always operates on a defined value
Updated tests: fixed ModuleLoader constructor call positions (undefined, undefined, openApiDocument), replaced setOpenApiDocument tests with in-place mutation tests verifying the proxy reflects document changes; added tests "reflects in-place document updates through the proxy" and "proxy reflects mutated document properties"
Added minor changeset

changeset-bot · 2026-04-03T22:53:04Z

🦋 Changeset detected

Latest commit: 7545c07

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
counterfact	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/664861d6-17f3-439b-baed-43e605555777

pmcelhaney

If the document is changed on disk make sure the object passed to the context object receives the updates.

One way to do that is to remove all top level keys and replace them.

…ges on disk Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/53970cc0-2272-47a9-9bf7-b596f44d221f

Copilot · 2026-04-03T23:09:36Z

If the document is changed on disk make sure the object passed to the context object receives the updates.

One way to do that is to remove all top level keys and replace them.

Done in commit 2cfdd55. ModuleLoader now has a setOpenApiDocument() method that removes all top-level keys from the stored document object and replaces them with the new document's keys — keeping the same object reference so existing Context instances see the update automatically.

In app.ts, the codeGenerator "generate" event (fired whenever the OpenAPI spec changes on disk) now reloads the document and calls moduleLoader.setOpenApiDocument(newDoc) + updates dispatcher.openApiDocument.

pmcelhaney

Maybe it would be smarter to assign openApiDocument reference to a Proxy that is read only.

…ent updates Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/a2639b7f-a7eb-4be6-a488-82b669d34a93

Copilot · 2026-04-03T23:40:32Z

Maybe it would be smarter to assign openApiDocument reference to a Proxy that is read only.

Done in commit 4c25b46. The openApiDocument passed to Context is now a read-only Proxy backed by a { current } ref. When setOpenApiDocument(newDoc) is called, it just swaps ref.current = newDoc — no mutation of the document object itself. All reads through the Proxy automatically reflect the latest document, and any attempt to set or delete properties returns false.

pmcelhaney

The .current property seems unnecessary. The object could just be assigned to openApiDocumentRef.

I don't understand why you wouldn't update the openApiDocument if it wasn't assigned originally. Make openApiDocumentRef default to an empty object if necessary.

If there are good reasons for either of these decisions, don't make changes. Just explain the reasoning.

Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/0dcac193-be27-4734-a435-80a0a6165d81

Copilot · 2026-04-04T00:26:56Z

The .current property seems unnecessary. The object could just be assigned to openApiDocumentRef.

I don't understand why you wouldn't update the openApiDocument if it wasn't assigned originally. Mak...

Done in commit a20b89c.

Dropped the .current wrapper — openApiDocumentRef now holds the document directly. The Proxy captures self = this in its handler closures, so every read goes through self.openApiDocumentRef and picks up any reassignment automatically.
openApiDocumentRef defaults to {} when no document is provided, so the Proxy is always created and setOpenApiDocument always works without any early-return guard.

pmcelhaney · 2026-04-06T20:40:43Z

@copilot TypeScript compilation is failing

src/server/module-loader.ts:53:5 - error TS2741: Property 'paths' is missing in type '{}' but required in type 'OpenApiDocument'.

53 openApiDocument: OpenApiDocument = {},
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/server/dispatcher.ts:60:3
60 paths: {
~~~~~
'paths' is declared here.

Found 1 error in src/server/module-loader.ts:53

…ault Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/fa04ab4b-7c2e-4875-b19c-6ca60bd4d9e6

Copilot · 2026-04-06T20:44:12Z

@copilot TypeScript compilation is failing

...

Fixed in commit 05a3c31. Made paths optional in the OpenApiDocument interface in dispatcher.ts — an empty {} is semantically valid when no spec is loaded, and the for...in loop in dispatcher.ts already handles undefined paths gracefully.

pmcelhaney · 2026-04-13T15:49:58Z

@copilot resolve conflicts

Agent-Logs-Url: https://github.com/counterfact/api-simulator/sessions/0882ced2-3d8c-4dc5-b3da-2660fd4806cd

Copilot · 2026-04-13T15:55:37Z

@copilot resolve conflicts

Done in commits e6096f0 and bbe62d6. The merge was already in place but it introduced a TypeScript error: making paths optional in OpenApiDocument broke route-builder.ts, which passed the possibly-undefined value to Object.keys(). Fixed by extracting paths ?? {} to a local variable so the loop body always operates on a defined value — no optional chaining needed. yarn tsc --noEmit now passes cleanly.

pmcelhaney · 2026-04-13T15:58:34Z

@copilot there are still merge conflicts

…ide ScenarioRegistry

Copilot · 2026-04-13T16:28:51Z

@copilot there are still merge conflicts

Done in commit 023f8b7. Merged origin/main (which introduced OpenApiDocument as a self-updating class, ScenarioRegistry, and more) and resolved all three conflicts:

dispatcher.ts: removed our duplicate optional interface; kept main's required-paths version
module-loader.ts: combined main's scenariosPath/scenarioRegistry parameters with our openApiDocument proxy; simplified the proxy since the new class updates its properties in-place on reload
app.ts: pass both scenarios args and openApiDocument to ModuleLoader; dropped the now-redundant codeGenerator.generate listener (superseded by openApiDocument?.watch())

yarn tsc --noEmit passes cleanly and all 20 module-loader tests pass.

pmcelhaney · 2026-04-13T17:02:15Z

Somehow the call stack is getting blown when I try to use this. It's not a very important feature right now so I'm going to let it go.

Initial plan

1db473a

Copilot AI assigned Copilot and pmcelhaney Apr 3, 2026

Copilot started work on behalf of pmcelhaney April 3, 2026 22:53 View session

Copilot AI linked an issue Apr 3, 2026 that may be closed by this pull request

Pass the OpenAPI document to the constructor of the context class #968

Closed

Pass openApiDocument to Context constructor in module-loader

7c237fa

Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/664861d6-17f3-439b-baed-43e605555777

Copilot AI changed the title ~~[WIP] Pass the OpenAPI document to the constructor of the context class~~ Pass OpenAPI document to Context class constructor Apr 3, 2026

Copilot AI requested a review from pmcelhaney April 3, 2026 23:00

Copilot finished work on behalf of pmcelhaney April 3, 2026 23:00

pmcelhaney requested changes Apr 3, 2026

View reviewed changes

Copilot started work on behalf of pmcelhaney April 3, 2026 23:02 View session

Ensure openApiDocument updates reach Context instances when spec chan…

2cfdd55

…ges on disk Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/53970cc0-2272-47a9-9bf7-b596f44d221f

Copilot AI requested a review from pmcelhaney April 3, 2026 23:10

Copilot finished work on behalf of pmcelhaney April 3, 2026 23:10

pmcelhaney requested changes Apr 3, 2026

View reviewed changes

Copilot started work on behalf of pmcelhaney April 3, 2026 23:35 View session

Replace in-place key mutation with a read-only Proxy for openApiDocum…

4c25b46

…ent updates Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/a2639b7f-a7eb-4be6-a488-82b669d34a93

Copilot finished work on behalf of pmcelhaney April 3, 2026 23:41

Copilot AI requested a review from pmcelhaney April 3, 2026 23:41

pmcelhaney requested changes Apr 4, 2026

View reviewed changes

Copilot started work on behalf of pmcelhaney April 4, 2026 00:23 View session

Simplify Proxy: drop .current wrapper, default openApiDocumentRef to {}

a20b89c

Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/0dcac193-be27-4734-a435-80a0a6165d81

Copilot finished work on behalf of pmcelhaney April 4, 2026 00:27

Copilot AI requested a review from pmcelhaney April 4, 2026 00:27

pmcelhaney approved these changes Apr 4, 2026

View reviewed changes

pmcelhaney marked this pull request as ready for review April 4, 2026 01:06

Copilot AI requested a review from pmcelhaney April 6, 2026 20:30

Copilot finished work on behalf of pmcelhaney April 6, 2026 20:30

Copilot started work on behalf of pmcelhaney April 6, 2026 20:40 View session

Fix TS2741: make paths optional in OpenApiDocument to allow empty def…

05a3c31

…ault Agent-Logs-Url: https://github.com/pmcelhaney/counterfact/sessions/fa04ab4b-7c2e-4875-b19c-6ca60bd4d9e6

Copilot finished work on behalf of pmcelhaney April 6, 2026 20:45

github-actions Bot and others added 9 commits April 7, 2026 00:19

Merge branch 'main' into copilot/pass-openapi-document-to-context

d653169

Merge branch 'main' into copilot/pass-openapi-document-to-context

fdffde6

Merge branch 'main' into copilot/pass-openapi-document-to-context

6a62ed1

Merge branch 'main' into copilot/pass-openapi-document-to-context

814ba54

Merge branch 'main' into copilot/pass-openapi-document-to-context

fae0bcc

Merge branch 'main' into copilot/pass-openapi-document-to-context

0c8e6ff

Merge branch 'main' into copilot/pass-openapi-document-to-context

7545c07

Merge branch 'main' into copilot/pass-openapi-document-to-context

4fd18fd

Merge branch 'main' into copilot/pass-openapi-document-to-context

04b7b69

Copilot started work on behalf of pmcelhaney April 13, 2026 15:50 View session

Copilot AI added 2 commits April 13, 2026 15:53

Fix TypeScript error in route-builder.ts: guard against undefined paths

e6096f0

Agent-Logs-Url: https://github.com/counterfact/api-simulator/sessions/0882ced2-3d8c-4dc5-b3da-2660fd4806cd

Improve route-builder.ts path guard: extract paths to local variable

bbe62d6

Agent-Logs-Url: https://github.com/counterfact/api-simulator/sessions/0882ced2-3d8c-4dc5-b3da-2660fd4806cd

Copilot finished work on behalf of pmcelhaney April 13, 2026 15:57

Copilot started work on behalf of pmcelhaney April 13, 2026 16:16 View session

Merge origin/main: preserve openApiDocument-to-Context feature alongs…

023f8b7

…ide ScenarioRegistry

Copilot finished work on behalf of pmcelhaney April 13, 2026 16:30

Merge branch 'main' into copilot/pass-openapi-document-to-context

461dd93

pmcelhaney closed this Apr 13, 2026

Uh oh!

Uh oh!

Conversation

Copilot AI commented Apr 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Manual acceptance tests

Tasks

Uh oh!

changeset-bot Bot commented Apr 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

pmcelhaney left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 3, 2026

Uh oh!

pmcelhaney left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 3, 2026

Uh oh!

pmcelhaney left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Apr 4, 2026

Uh oh!

pmcelhaney commented Apr 6, 2026

Uh oh!

Copilot AI commented Apr 6, 2026

Uh oh!

pmcelhaney commented Apr 13, 2026

Uh oh!

Copilot AI commented Apr 13, 2026

Uh oh!

pmcelhaney commented Apr 13, 2026

Uh oh!

Copilot AI commented Apr 13, 2026

Uh oh!

pmcelhaney commented Apr 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Apr 3, 2026 •

edited

Loading

changeset-bot Bot commented Apr 3, 2026 •

edited

Loading